This document provides installation instructions for using ODF with MPW based compilers.
Table of Contents
-------------------------
• Step 1 - Installing MPW from ETO #21
• Step 2 - Installing MPW Additions
• Step 3 - Copying ODFDev
• Step 4 - Locating ODF, OpenDoc and Cyberdog folders
• Step 5 - Making an alias to the ODF library (and sample parts).
Step 1 - Installing MPW from ETO #21
Install MPW ('MPW' and 'Interfaces&Libraries' folders) from the ETO 21 CD. This is the version of ETO you should be using. Previous version of ETO might give you unexpected results.
Step 2 - Installing MPW Additions
Open the MPW Additions folder, it contains two folders:
• folder 'INTO Interfaces&Libraries'
This folder contains the headers and libraries for Cyberdog 1.1 (Cyberdog SDK folder) and OpenDoc 1.1 (OpenDoc folder). Move the contents of this folder into your 'Interfaces&Libraries' folder. Cyberdog headers and libraries are now required to build some ODF 2 components, such as the Internet layer or the ODFBitmap sample part. (Cyberdog is not required to run the ODFBitmap sample part.)
• folder 'INTO Startup Items'
This folder contains the “UserStartup•ODF” (for MPW) and “UserStartupTS•ODF” (for ToolServer) files. Move the appropriate file into your 'Startup Items' (or 'TS Startup Items') folder located inside the MPW folder. Note: you will need to relaunch MPW (see step 4).
Note: Some scripts and tools used by the ODF build system are located in the “ODF:Tools:Mac:” folder. The startup scripts add this path to your command path automatically.
Step 3 - Copying ODFDev
Copy the ODFDev folder in its entirety to your local hard drive. This folder contains the ODF source code and the source code for ODF's example parts. The “ODFDev:ODF:” subfolder contains configurations and project setups for building the ODF libraries.
The ODF folder and the folders for each sample part contain multiple subfolders folders that specify the build configurations for each development environment. Inside these folders are project files and build scripts required for building ODF (or the sample part) with the specified development environment. Once you have copied the ODFDev folder to your local hard drive, you can throw away the folders for any development environments you are not using.
For building part editors with MPW, you need to keep only the folders that use the MrC and/or Symantec compilers, depending on your configuration. For building ODF's shared libraries, you must keep the Shared Library folders.
The following table lists the folder name, the supported compiler, and the resulting configuration for the ODF library or part editor. Notice that the 68K ODF Shared Library is currently built with the MPW Symantec 68K compiler and the PPC ODF Shared Library is always built with CodeWarrior.
Folder Compiler Resulting ODF Libraries Resulting Sample Part
The following table indicates which folders are necessary for each supported compiler.
Folder CW/PPC CW/68K Symantec68K MrC
CWPPCDebug Yes No No No
CWPPCRelease Yes No No No
MCPPCDebug No No No Yes
MCPPCRelease No No No Yes
CW68KDebug No Yes No No
CW68kRelease No Yes No No
SC68KDebug No No Yes No
SC68KRelease No No Yes No
SL68KDebug No Yes Yes No
SL68KRelease No Yes Yes No
SLPPCDebug Yes No No Yes
SLPPCRelease Yes No No Yes
Step 4 - Locating ODF, OpenDoc and Cyberdog folders
If your MPW shell is running, quit and relaunch it.
After launching MPW, you will be asked to locate your ODF folder and OpenDoc SDK folder.
For the ODF folder:
- Find your ODFDev folder and select the 'ODFDev:ODF:' folder
For the OpenDoc SDK folder:
- Find the 'OpenDoc' folder from the OpenDoc SDK. This folder should be located inside your “Interfaces&Libraries” folder (see step 2).
Once you locate these folders, MPW stores the paths to these folders in your MPW preferences folder (in the file ODF_Folder for the ODF path, and the files FWOpenDocInterfaces and FWOpenDocLibraries for the OpenDoc SDK). MPW will not prompt you for these folders again (unless the paths to these folders change).
Note: The ODF build system will locate automatically the CybderDog SDK which should also be inside your Interfaces&Libraries folder.
Step 5 - Making an alias to the ODF Library (and sample parts).
To make debugging with ODF easier, you should make an alias to the debug version of the ODF shared library and put that alias into your Editors folder. Debuggers use this alias during debugging sessions to trace your code's execution into the ODF shared library.
If your ODFDev folder is on a different volume than your system folder, you can create an Editors folder at the root level of your development hard drive and put the alias there. (OpenDoc does not allow you to put aliases to files on different volumes in the Editors folder.)
Note: The ODFLibrary (or an alias to it) must be located in your Editors folder. Part editors that were built with ODF require the existence of this library and will not run without it.
The debug versions of the ODF shared library (ODFLibrary) are already built. The ODFLibrary for PowerPC is located in the "ODFDev:ODF:SLPPCDebug:Bin:" folder. The ODFLibrary for 68K is located in the “ODFDef:ODF:SL68KDebug:Bin:” folder.
If you want to debug the ODF sample parts, you can also add an alias to each of these part editors to your Editors folder. The debug version of an ODF part editor is located within either the "MCPPCDebug:Bin:" folder for PowerPC or the “SC68KDebug:Bin:” folder for 68K of the particular sample part. For example, the debug PowerPC part editor for ODFDraw is located in the “ODFDev:Draw:MCPPCDebug:Bin:” folder.
For convenience, you can also make an alias to the symbol files for the ODFLibrary (ODFLibrary.xSYM) and put it on your desktop. You can then use this alias to find the ODFLibrary debugging information quickly when you launch your debugger.
IMPORTANT: Make sure that the release version of the ODFLibrary or any of the ODF sample parts are not installed on your machine while you are attempting to trace through either the ODFLibrary or sample parts. The chances are good that you will not get the right library. OpenDoc searches for the first part editor and library that matches its search parameters. The release version of the ODF libraries and samples are simply optimized versions that do not have internal debugging information, such as Macsbug symbols or assertions.
